Skip to main content

Http Request

Composes a request to an endpoint url, executes it and returns the response in a string format, saving the resource if specified. It has authentication capabilities allowing communication with secured endpoints.

Input​

  • Accept Format: The format of the response required from the server.
    • Type: System.Int32
    • Dropdown Options:
      • ANY
      • XML
      • JSON
      • Custom
  • Request Method: Type of the request method.
    • Type: System.Int32
    • Required
    • Dropdown Options:
      • GET
      • POST
      • PUT
      • DELETE
      • HEAD
      • OPTIONS
      • PATCH
      • MERGE
  • Request URL: URL to which the request is made
    • Type: System.String
    • Required

Options​

  • Attachments: Dictionary of file paths to upload to the request.
    • Type: System.Collections.Generic.IDictionary<System.String, System.Activities.Argument>
  • Body: Body of the request
    • Type: System.String
  • Body Format: It defines body formats in the request.
    • Type: System.Int32
    • Dropdown Options:
      • Json
      • Xml
      • Plain
      • Binary
      • GZip
      • FormUrlEncoded
      • Undefined
  • Cookies: A Cookie is a small text based file given to you by a visited website that helps identify you to that site. Dictionary of the cookies.
    • Type: System.Collections.Generic.IDictionary<System.String, System.Activities.Argument>
  • File name of Response Attachment: Dictionary of the paths to upload to the request.
    • Type: System.String
  • Headers: Dictionary of requests header.
    • Type: System.Collections.Generic.IDictionary<System.String, System.Activities.Argument>
  • Parameters: Parameters of the request.
    • Type: System.Collections.Generic.IDictionary<System.String, System.Activities.Argument>
  • URL Segments: Dictionary of key/value pairs that are added to the url. An URL segment parameter replaces placeholder values in the url, by specifiying in the url /{key} format.
    • Type: System.Collections.Generic.IDictionary<System.String, System.Activities.Argument>

Output​

  • Headers: Dictionary of the outputs of headers.
    • Type: System.Collections.Generic.Dictionary<System.String, System.String>
  • Response Attachment: Attachment saved from the EndPoint.
    • Type: ArenaRobotics.Domain.Entities.ResourceHandling
  • Response Content: The response received from the EndPoints.
    • Type: System.String
  • Response Status: Http response status.
    • Type: System.Int32

Client Certificate Authentication​

  • Client Certificate: A path to certificate used to authenticate the request.
    • Type: System.String
  • Client Certificate Password: Gets client certificate password.
    • Type: System.String
  • Enable SSL Verification: Enable SSL verification for the request.
    • Type: System.Boolean
  • Secure Client Certificate Password: Encrypted certificate password.
    • Type: System.Security.SecureString

Common​

  • Continue On Error: Continue even if error occurs.
    • Type: System.Boolean
  • Timeout: Timeout to wait for the request to be completed.
    • Type: System.Int32

OAuth 1​

  • Consumer Key: The key used by the OAuth1 authentication protocol describing the client's credentials.
    • Type: System.String
  • Consumer Secret: The secret used by the OAuth1 authentication protocol describing the client's credentials.
    • Type: System.String
  • OAuth 1 Token: User
    • Type: System.String
  • OAuth1 Token Secret: The secret used by the OAuth1 authentication protocol after an authorization request for the consumer has been approved.
    • Type: System.String

OAuth 2​

  • OAuth 2 Token: The token used by the OAuth2 authentication protocol. It is issued by the targeted service and may need a renewal.
    • Type: System.String

Simple Authentication​

  • Password: The Password for the user issuing this request. If Username and Password properties are set, The request is done using Basic Authorization protocol.
    • Type: System.String
  • Secure Password: The encrypted password for the user issuing this request. If Username and Password properties are set, The request is done using Basic Authorization protocol.
    • Type: System.Security.SecureString
  • Username: A user name for the authenticated request. A password should also be specified. If Username and Password properties are set, the request is done using Basic Authorization protocol.
    • Type: System.String